home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 7 / Apprentice-Release7.iso / Environments / Small Eiffel 0.4.8 / man / pretty.hlp < prev    next >
Text File  |  1997-04-13  |  2KB  |  54 lines
  1. pretty [options] <Class_names> ...
  2.  
  3. Command `pretty' is the SmallEiffel Pretty Printer for Eiffel 
  4. source files. For all classes given as arguments, pretty
  5. looks for the corresponding file using the same algorithm as
  6. command `finder'. All the corresponding files are reprinted
  7. in a `pretty' way.
  8.  
  9. For example, if you are allowed to write the corresponding 
  10. file, you can reprints the source file of class HELLO_WORLD
  11. using command :
  12.  
  13.    pretty hello_world
  14.  
  15. There are four modes of pretty printing -zen, -default, -end
  16. and -parano mode. Only one mode can be selected and mode 
  17. -default is the default mode.
  18.  
  19. 1- Options for pretty printing -
  20.  
  21. -zen : The less you can print. Pseudo variable `Current' is 
  22.    never printed (unless it is necessary). No end mark comment
  23.    for routines. No end comments for constructs (if, inspect, 
  24.    debug, ...). Very compact printing.
  25.  
  26. -default : the default mode. Don't change printing of pseudo
  27.    variable `Current' (if Current is in the input, Current is
  28.    in the output). Print end comment of routines.
  29.    Don't print end comments for constructs (if, inspect, 
  30.    debug, ...).
  31.        
  32. -end : Same printing as previous mode but print ends of all 
  33.    constructs (if, inspect, debug, ...).
  34.  
  35. -parano : Same printing as previous mode but prints `Current' 
  36.    everywhere you can.
  37.  
  38. 2- Security and BackUp file -
  39.  
  40. For the security of sources files, a backup file is created 
  41. before writting the new file (system or command `pretty' may
  42. crash during printing of the new file).
  43. The backup file name is "foo.bak" when source file name is 
  44. "foo.e". Backup file is written in the same directory as 
  45. source file. 
  46. If an old backup file already exists before pretty printing, 
  47. command `pretty' exit with an error message.
  48. To be sure that the pretty printing is well done, the output 
  49. file is parsed again.
  50. Even if second parsing gives no errors, backup file is NOT 
  51. removed. Thus you can recompile your Eiffel code to check
  52. new file before removing backup file by yourself.
  53.  
  54.